/************************************
*  Copyright (C) 2010 Julien MOTTIN.
*  Contact: julien.mottin@gueydan.eu
*
*  This file is part of Gueydan.
*
*  Gueydan is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  Gueydan is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with Gueydan.  If not, see <http://www.gnu.org/licenses/>.
*
*************************************/
#ifndef FERMENTABLE_H
#define FERMENTABLE_H

// Local
#include "beerxmlobject.h"
#include "weight.h"
#include "color.h"

// QtCore
#include <QString>

enum FermentableType
{
    FTGrain = 0,
    FTSugar,
    FTExtract,
    FTDryExtract,
    FTAdjunct
};

class QDomNode;

class Fermentable : public BeerXMLObject
{
	Q_OBJECT;
	
public:

    // Standard Constructor with all mandatory fields
    Fermentable(const QString &iName,
                const int iVersion,
                const FermentableType iType,
                const Weight &iAmount,
                const float iYield,
                const Color &iColor);

    // Empty ctor
    Fermentable();

    // Dtor
    ~Fermentable();

    // Conveniance Operators
    bool operator==(const Fermentable & iOther) const;
    bool operator!=(const Fermentable & iOther) const;

    /*
    * XML IO
    * returns :
    *   - 0 : Success
    *   - 1 : Invalid XML
    */
    int CreateFromXMLNode(const QDomNode &iNode);
    int ToXMLNode(QDomNode &iParentNode) const;

public:

    // internal data
    FermentableType _Type;
    Weight          _Amount;
    float           _Yield;
    Color           _Color;
    bool            _AddAfterBoil;
    QString         _Origin;
    QString         _Supplier;
    QString         _Notes;
    float           _CoarseFineDiff;
    float           _Moisture;
    float           _DiastaticPower;
    float           _Protein;
    float           _MaxInBatch;
    bool            _RecommendMash;
    float           _IBUGalPerLB;

private:
    Fermentable(const Fermentable &);
    Fermentable & operator=(const Fermentable &);
};

#endif // FERMENTABLE_H

